Client Configuration API
This section describes the API functions that allow the licensed application to retrieve or overwrite the default settings.
Given below is the list of the API functions:
| Function | Description |
|---|---|
| VLSsetContactServer | Sets the License Manager to be contacted. |
| VLSgetContactServer | Retrieves the License Manager’s host name/IP address. |
| VLSsetServerPort | Sets the License Manager’s communication port. |
| VLSgetServerPort | Obtains the License Manager’s communication port. |
| VLSinitMachineID | Sets the fields in machineID to default values. |
| VLSgetMachineID | Sets machineID values for the current host. |
| VLSgetMachineIDOld | Sets machineID values for the current host. However, this is based on the logic used by earlier version licenses, viz, the version 9 and 10 licenses. For version 11 (and later) licenses, VLSgetMachineID is used. |
| VLSgetNumberedMachineID | Obtains the CID, Ethernet, and custom extended fingerprint at the specified index location for the current host. |
| VLSgetNumberedMachineIDExt | Obtains the CID, Ethernet, and custom extended fingerprint at the specified index location for a specific License Manager. |
| VLSsetHostIdFunc | Register the custom fingerprint mechanism with the client library. |
| VLSsetCustomExFunc | Registers the extended custom fingerprint mechanism with the client library. |
| VLSmachineIDtoLockCode | Computes the previous version (old style) locking codes. |
| VLSmachineIDtoLockCodeEx | Computes the new style locking codes. |
| VLSgetServerNameFromHandle | Retrieves the License Manager’s name based on handle_id. |
| VLSinitServerList | Initializes a list of default License Managers to search for a license in case of broadcast. |
| VLSgetServerList | Retrieves the default License Manager list. |
| VLSinitServerInfo | Initializes the License ManagerInfo data structure to default values. |
| VLSsetBroadcastInterval | Configures broadcast behavior. |
| VLSgetBroadcastInterval | Retrieves broadcast behavior parameters. |
| VLSsetTimeoutInterval | Configures timeout behavior. |
| VLSgetTimeoutInterval | Retrieves timeout behavior parameters. |
| VLSsetHoldTime | Sets license hold time. |
| VLScontrolRemoteSession | Allows or prohibits use of the licensed application through remote sessions in the standalone licensing environments. |
| VLSsetSharedId/ VLSsetTeamId |
Redefines shared ID functions. |
| VLSsetSharedIdValue/ VLSsetTeamIdValue | Registers a customized shared ID value. |
| VLSsetGraceRequestFlag | Sets the behavior if a grace license can be requested or not when the contact License Manager has been set to standalone mode (no-net). |
| VLSgetGraceRequestFlag | Obtains the status if the grace license request is enabled or not when the contact License Manager has been set to standalone mode (no-net). |
| VLScalculateLicenseHash | Calculates the license hash for a given license string. |
| VLSisVirtualMachine | Reports whether the License Manager is running on a virtual machine or not. |
| VLSscheduleEvent | Schedules event handler to be awakened after so many seconds. It handles only SIGALRM signal. |
| VLSdisableEvents | Disables the events scheduled. To disable a particular event pass the event handler function name as the argument. To disable all the events pass NULL as argument. |
| VLSeventSleep | Disables the feature for an allotted time. |
| VLSsetMinimumSigningKeyIndex | Specifies the minimum signing key index for restricting consumption to the more secure RSA signed licenses. |